<?php 
//php注释模板

//1、文件头部注释模板
/**
 * 这是一个什么文件
 * 此文件是用来做什么（详细说明）
 * @author Chr
 * @version 定义版本 信息
 * @since 1.0 指明api函数或者 方法是从哪个版本开始引入的 
 */

//2、函数头部注释
/**
 * this_function
 * 函数的含义命名
 * 
 * @Author   Chr
 * @DateTime 2018-03-13
 * @param    [type]     $string  [description]
 * @param    [type]     $integer [description]
 * @param    [type]     $mixed   [description]
 * @return   [type]              [description]
 */
function this_function($string, $integer, $mixed)
{
	# code...
	return array();
}

//3、类的注释

/**
 * 类的介绍
 *
 * 类的详细介绍
 * @author Chr
 * @since 1.0
 */
class Test
{
	
	function __construct()
	{
		# code...
	}
}

//4、常用注释解释
/**
 * @name 名字
 * @abstract 申明变量、类、方法
 * @access 指明这个变量、类、函数、方法存取权限
 * @author 函数作者的名字和邮箱地址 
 *
 * @category 组织
 * @copyright 指明版权信息
 * @const 指明常量
 * @deprecated 指明不推荐或者是废弃的信息
 * @example  示例 [<description>]
 * @exclude 指明当前的注释将不进行分析，不出现在文挡中
 * @final 指明这是一个最终的类、方法、属性，禁止派生、修改。
 * @global 指明在此函数中引用的全局变量
 * @include 指明包含的文件的信息
 * @link 定义在线连接
 * @module 定义归属的模块信息
 * @modulegroup 定义归属的模块组
 * @package 定义归属的包的信息
 * @param 定义函数或者方法的参数信息
 * @return 定义函数或者方法的返回信息
 * @see 定义需要参考的函数、变量，并加入相应的超级连接。
 * @since 指明该api函数或者方法是从哪个版本开始引入的
 * @static 指明变量、类、函数是静态的。
 * @throws 指明此函数可能抛出的错误异常,极其发生的情况
 * @todo 指明应该改进或没有实现的地方
 * @var 定义说明变量/属性。
 * @version 定义版本信息
 */


?>
